Skip to content

fix: show hydrated profile avatars in Studio header#670

Open
edschema wants to merge 1 commit intoopenedx:masterfrom
Schema-Education:schema/avatar-fix
Open

fix: show hydrated profile avatars in Studio header#670
edschema wants to merge 1 commit intoopenedx:masterfrom
Schema-Education:schema/avatar-fix

Conversation

@edschema
Copy link
Copy Markdown

Description

Studio header avatar rendering currently only checks authenticatedUser.avatar. That preserves the legacy header avatar contract, but it misses uploaded Open edX profile images because those image URLs are returned by the hydrated account payload under authenticatedUser.profileImage.

This change keeps the existing authenticatedUser.avatar behavior and adds a fallback to hydrated account profile image data when available:

  • prefer authenticatedUser.avatar
  • otherwise use authenticatedUser.profileImage.imageUrlMedium when profileImage.hasImage is true
  • otherwise preserve the existing Paragon fallback avatar behavior

This does not change backend profile-image APIs, JWT contents, or fallback rendering responsibilities.

Supporting Context

The corresponding Studio app change should enable authenticated-user hydration in frontend-app-authoring. That app-level change should be staged after this package change is released, because Studio must consume the released @edx/frontend-component-header version containing this normalization.

Testing

npm test -- --runTestsByPath src/studio-header/StudioHeader.test.tsx --runInBand
npm run types

The targeted test suite covers:

  • no uploaded image fallback
  • hydrated profileImage.hasImage: false fallback
  • hydrated profileImage.hasImage: true image rendering
  • legacy authenticatedUser.avatar priority

@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Apr 30, 2026

Thanks for the pull request, @edschema!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 30, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 30, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.07%. Comparing base (a1df9a9) to head (bdbb919).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #670      +/-   ##
==========================================
+ Coverage   72.97%   73.07%   +0.10%     
==========================================
  Files          60       60              
  Lines         518      520       +2     
  Branches      108      110       +2     
==========================================
+ Hits          378      380       +2     
  Misses        137      137              
  Partials        3        3              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants